MinerApi

All URIs are relative to //api.estuary.tech/

Method	HTTP request	Description
MinerClaimMinerGet	Get /miner/claim/{miner}	Get Claim Miner Message
MinerClaimPost	Post /miner/claim	Claim Miner
MinerSetInfoMinerPut	Put /miner/set-info/{miner}	Set Miner Info
MinerSuspendMinerPost	Post /miner/suspend/{miner}	Suspend Miner
MinerUnsuspendMinerPut	Put /miner/unsuspend/{miner}	Unuspend Miner
PublicMinersDealsMinerGet	Get /public/miners/deals/{miner}	Get all miners deals
PublicMinersStatsMinerGet	Get /public/miners/stats/{miner}	Get miner stats

MinerClaimMinerGet

ApiClaimMsgResponse MinerClaimMinerGet(ctx, miner) Get Claim Miner Message

This endpoint lets a user get the message in order to claim a miner

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
miner	string	Miner claim message

Return type

ApiClaimMsgResponse

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

MinerClaimPost

ApiClaimResponse MinerClaimPost(ctx, body) Claim Miner

This endpoint lets a user claim a miner

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	MinerClaimMinerBody	Claim Miner Body

Return type

ApiClaimResponse

Authorization

bearerAuth

HTTP request headers

• Content-Type: /
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

MinerSetInfoMinerPut

ApiEmptyResp MinerSetInfoMinerPut(ctx, body, miner) Set Miner Info

This endpoint lets a user set miner info.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	MinerMinerSetInfoParams	Miner set info params
miner	string	Miner to set info for

Return type

ApiEmptyResp

Authorization

bearerAuth

HTTP request headers

• Content-Type: /
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

MinerSuspendMinerPost

ApiEmptyResp MinerSuspendMinerPost(ctx, body, miner) Suspend Miner

This endpoint lets a user suspend a miner.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	MinerSuspendMinerBody	Suspend Miner Body
miner	string	Miner to suspend

Return type

ApiEmptyResp

Authorization

bearerAuth

HTTP request headers

• Content-Type: /
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

MinerUnsuspendMinerPut

ApiEmptyResp MinerUnsuspendMinerPut(ctx, miner) Unuspend Miner

This endpoint lets a user unsuspend a miner.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
miner	string	Miner to unsuspend

Return type

ApiEmptyResp

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PublicMinersDealsMinerGet

string PublicMinersDealsMinerGet(ctx, miner, optional) Get all miners deals

This endpoint returns all miners deals

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
miner	string	Filter by miner
optional	*MinerApiPublicMinersDealsMinerGetOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a MinerApiPublicMinersDealsMinerGetOpts struct Name | Type | Description | Notes ------------- | ------------- | ------------- | -------------

ignoreFailed | optional.String| Ignore Failed |

Return type

string

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PublicMinersStatsMinerGet

string PublicMinersStatsMinerGet(ctx, miner) Get miner stats

This endpoint returns miner stats

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
miner	string	Filter by miner

Return type

string

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]